home *** CD-ROM | disk | FTP | other *** search
/ PC Media 4 / PC MEDIA CD04.iso / share / udos / sdir32 / sdir32.doc < prev    next >
Encoding:
Text File  |  1991-07-17  |  15.1 KB  |  371 lines
  1. SmartDir 3.2 Documentation
  2.  
  3. Written by Owen Emry
  4. Compiled July 17, 1991
  5.  
  6.  
  7.  
  8. Contents
  9.  
  10.  1.  What is SmartDir?
  11.  2.  How to install SmartDir
  12.       1.  File Descriptions
  13.       2.  Installation
  14.       3.  Using SDIRCFG.EXE
  15.       4.  Using SDEDIT.EXE
  16.  3.  How to use SmartDir
  17.       1.  Executing SmartDir from the Dos prompt
  18.       2.  Usage
  19.       3.  Detailed Option List
  20.  4.  Version History
  21.  5.  Disclaimer
  22.  6.  Shareware Registration Information
  23.  
  24.  
  25.  
  26.  1.  What is SmartDir?
  27.  
  28. SmartDir is a full-featured command-line directory utility comparable
  29. to that provided by the Dos DIR command, yet is far superior in many
  30. ways.  In addition to those features provided by the DIR command,
  31. SmartDir contains many features of its own, making it the most powerful
  32. shareware directory utility available.
  33.  
  34. The following features are availble ONLY with SmartDir:
  35.  
  36. o  Color
  37. o  Multi-column modes ranging from 1 through 6
  38. o  Output sorted by Name, Extension, Size, or Date (or not at all)
  39. o  Optional inclusion of Hidden, Read-Only, and Volume ID files
  40. o  Lowercase output, generally accepted as easier to read
  41. o  Direction of output (including ANSI color) to Disk Files (or printer)
  42. o  EGA/VGA 43/50-line mode (for those really big directories)
  43. o  Free space displayed in bytes, Kilobytes, Megabytes, Gigabytes, Percent
  44. o  File Descriptions (up to 55 characters)
  45.  
  46.  
  47.  2.  How to install SmartDir
  48.  
  49.       1.  File Descriptions
  50.  
  51. The following files should be included in the file SDIR3x.ZIP:
  52.  
  53.   SDIR.EXE     --  This is SmartDir
  54.   SDIRxx.DOC   --  This documentation file
  55.   SDIRCFG.EXE  --  SmartDir configuration program
  56.   SDEDIT.EXE   --  SmartDir File Description Editor
  57.   ORDER.TXT    --  Order form for paid registrations
  58.  
  59.       2.  Installation
  60.  
  61. SmartDir is installed by placing the file SDIR.EXE into a subdirectory
  62. specified in your PATH statement.  This allows SmartDir to be executed
  63. from any location within your disks.
  64.  
  65. For example, if you are installing SmartDir on your C drive, locate
  66. a subdirectory specified in your PATH statement, such as C:\UTILS.
  67. If you have no such subdirectory, make one with the Dos MD command,
  68. and make sure the following statement is in your AUTOEXEC.BAT file:
  69.  
  70. path=c:\utils;
  71.  
  72. Then, copy the file SDIR.EXE into the directory.  That's all there is to it.
  73.  
  74.       3.  Using SDIRCFG.EXE
  75.  
  76. SDIRCFG is a program used to automatically set the default options you
  77. desire.  By using SDIRCFG, you can save yourself the trouble of adding
  78. your most frequently used options to the command line each time you
  79. run SDIR.  SDIRCFG searches all directores in your PATH statement for
  80. a file called SDIR.CFG (not to be confused with SDIRCFG.EXE).  The
  81. configuration is loaded if the file is found, otherwise the user is
  82. prompted to enter the name of the configuration file to create.  The
  83. file should be in a directory in your PATH statement in order for SDIR
  84. to find it.
  85.  
  86.       4.  Using SDEDIT.EXE
  87.  
  88. SDEDIT is a program used to attach file descriptions to files listed by
  89. SmartDir.  The first time it is used, a data file must be specified in
  90. which to store the file description data.  This is similar to the config
  91. file used by SDIRCFG.  Options within SDEDIT are fairly self-explanatory.
  92.  
  93. NOTE:  Unregistered copies of SDEDIT.EXE are not capable of adding file
  94.        descriptions to more than 50 files at one time.  Therefore, if
  95.        you wish to take full advantage of the power of file descriptions,
  96.        you MUST register your copy!  Registration is only ten dollars!
  97.  
  98.  
  99.  
  100.  3.  How to use SmartDir
  101.  
  102.       1.  Executing SmartDir from the Dos prompt
  103.  
  104. If you have properly installed the file SDIR.EXE into a subdirectory
  105. specified in your path statement, SmartDir may be executed by typing
  106. "sdir" at the Dos prompt.
  107.  
  108.       2.  Usage
  109.  
  110. SmarDir Usage is just like that of Dos, as follows:
  111.  
  112. sdir [pathname] [/options]
  113.  
  114. Item(s) in brackets is/are optional.  If [pathname] is not specified, the
  115. default (current) drive and directory are used.
  116.  
  117.       3.  Detailed Option List
  118.  
  119. SmartDir Options:
  120.  
  121.  
  122.   Help Screens:
  123.  
  124.     I     --     Displays Shareware Registration Information.  Use this
  125.                  option if you would like to Register your copy of
  126.                  SmartDir, or for a description of the Shareware concept.
  127.  
  128.     ?     --     Diplays a brief listing of all available SmartDir options.
  129.  
  130.  
  131.   Sort Methods:
  132.  
  133.     N     --     Sort output by Name.  (Default sort method)  This option
  134.                  causes all output to be alphabetized by the 8-character
  135.                  name field.
  136.  
  137.     E     --     Sort output by Extension.  This option causes all output
  138.                  to be alphabetized by the 3-character file extension.
  139.  
  140.     S     --     Sort output by SIZE.  This option causes all output to
  141.                  be sorted in ascending order by the size (in bytes)
  142.                  of the files.
  143.  
  144.     D     --     Sort output by Date and Time.  This option causes all
  145.                  output to be sorted chronologically.
  146.  
  147.     O     --     Do not sort.  This option causes all output to be
  148.                  displayed in the order it is physically stored on the
  149.                  disk.  Note:  This is not necessarily in any order
  150.                  other than that of actual physical storage, and is
  151.                  the order normally displayed by the Dos DIR command.
  152.  
  153.  
  154.   Multi-Column Modes:
  155.  
  156.     1     --     One-Column mode.  (default column mode)  Displays all
  157.                  file data, including name, extension, size, date, and time.
  158.  
  159.     2     --     Two-Column mode.  Displays directory in 2 columns.
  160.                  Otherwise, identical
  161.                  to one-column mode.
  162.  
  163.     3     --     Three-Column mode.  Displays directory in 3 columns,
  164.                  displaying name, extension, and size.
  165.  
  166.     4     --     Four-Column mode.  Displays directory in 4 columns,
  167.                  displaying name, extension, and size.  Size is displayed
  168.                  in kilobytes (1024 bytes) or megabytes (1024 kilobytes)
  169.                  as follows:  If the file is less than 1k, size appears
  170.                  as " <1k".  Sizes up to 1M appear as "xxxk".  Sizes over
  171.                  1M appear as "x.xM".  Sizes over 10M appear as ">10M".
  172.  
  173.     5     --     Five-column mode.  Displays directory in 5 columns,
  174.                  displaying only filenames.  Subdirectories are preceded
  175.                  by ">".
  176.  
  177.     6     --     Six-column mode.  Displays directory in 6 columns,
  178.                  displaying only filenames.
  179.  
  180.     F     --     Single-column mode with file descriptions.  Displays
  181.                  name, extension, size, and a full 55 character file
  182.                  description, if one is available.
  183.  
  184.     B     --     Single-column mode with brief file descriptions.
  185.                  Displays exactly like One-column mode, but displays
  186.                  also the first 40 characters of the file description.
  187.  
  188.  
  189.   Optional Files:  (These options are available only to REGISTERED users)
  190.  
  191.     H     --     Toggle.  Show Hidden files.  This option causes all hidden
  192.                  files to be displayed, in addition to all normal files.
  193.  
  194.     R     --     Toggle.  Show Read-only files.  This option causes all
  195.                  read-only files to be displayed, in addition to all normal
  196.                  files.
  197.  
  198.     V     --     Toggle.  Show Volume ID file.  This option causes the
  199.                  Volume ID file to be displayed, in addition to all normal
  200.                  files.
  201.  
  202.  
  203.   Miscellaneous Options:
  204.  
  205.     U     --     Toggle.  Toggles Uppercase/Lowercase output.
  206.  
  207.     G     --     Toggle.  Toggles graphics (column dividers).  Use this
  208.                  option when sending output to a printer that does not
  209.                  properly display graphics characters.
  210.  
  211.     P     --     Toggle.  Toggles Page Breaks.  This option causes the output
  212.                  to pause after each screen of output.  Output resumes once a
  213.                  key is pressed.
  214.  
  215.     A     --     Toggle.  Toggles EGA/VGA 43/50-line mode.  This is useful
  216.                  for those really big directories.  The original text mode
  217.                  is restored upon completion.
  218.  
  219.     C     --     Toggle.  Toggles Color.  This option causes files with
  220.                  specific 3-character extensions to be displayed in color.
  221.                  When output is directed to a file, ANSI escape sequences are
  222.                  used to change colors.  Default color coding is as follows:
  223.  
  224.                  EXE, COM, BAT :  Light Blue
  225.                  TXT, DOC      :  Light Red
  226.                  ZIP           :  Light Magenta (Pink)
  227.                  GIF, PCX      :  LIght Green
  228.  
  229.  
  230.   Output Destination Option:
  231.  
  232.     +filename -- Use of this option causes all output to be directed to
  233.                  the disk file "filename" instead of to the screen.  If
  234.                  color is used, ANSI escape sequences included in the
  235.                  output text.  Output can be directed to a printer by
  236.                  specifying "PRN" or "LPT1" as the output file.
  237.  
  238.  
  239.   Toggle Options turn ON the specified function.  However, if that
  240.   function is specified as default with SDIRCFG, the use of that
  241.   option turns OFF the function.
  242.  
  243.   All options must be preceded by a slash (/).  Options may be stacked.
  244.  
  245.   For example:  "sdir /3cps+dirfile.txt"  selects the following:
  246.  
  247.   3-Column mode, Color, Page-breaks, sort by size, and directs output
  248.   to the file DIRFILE.TXT.
  249.  
  250.  
  251.  
  252.  4.  Version History
  253.  
  254.  1.0  --  o First Release, December 1990
  255.  
  256.  2.0  --  o Released January 1991
  257.           o Improved (perfected?) pathname interpretation.
  258.           o Added 4 and 6 column modes.
  259.           o Added /O sort method.  (displays physical order on disk)
  260.           o Added Color
  261.           o Added /L option.  (Lowercase)
  262.           o Added total byte count to drive stats.
  263.             (Now says "xxxxk in xxx file(s)")
  264.           o Extended sorting.  For example, in 1.0, if you sorted by name,
  265.             the file extensions were not necessarily sorted within the
  266.             name field, so "FILE.EXE" might appear before "FILE.COM".
  267.           o Added ">" marker for subdirectories in 5-column mode.
  268.           o Removed /W option.  Use /1-6 instead.
  269.           o Improved Documentation.  (This File)
  270.  
  271.  2.1      o Released February 1991
  272.           o /G (suppress graphics) option now also turns off color.
  273.             Useful for custom copies of SmartDir with color as default.
  274.           o Added /A option for EGA/VGA 43/50-line mode.
  275.           o ARCs are no longer supported!  (They are no longer pink, as
  276.             are ZIPs).  This is done in retaliation to SEA's unfair
  277.             attempts to trademark the ARC.  Besides, they're pretty
  278.             obsolete, anyway.
  279.  
  280.  3.0      o Released February 24, 1991
  281.           o Now includes SDIRCFG, a program to select default options.
  282.           o Free space on disk may now be specified in bytes, kilobytes
  283.             Megabytes, or Gigabytes.
  284.           o Most options are now "toggles".  This means that their function
  285.             is enabled/disabled by use of that option.  For example: /p
  286.             selects page breaks.  However, if page breaks are selected
  287.             as default with SDIRCFG, the /p turns OFF page breaks.
  288.  
  289.  3.01     o Released February 24, 1991 (a few hours after version 3.0)
  290.           o Fixed minor bugs in SDIR.EXE and SDIRCFG.EXE
  291.           o Release 3.0 still had the beta (ß) tag on the end of its
  292.             version number.  It read "SmartDir 3.0ß".
  293.  
  294.  3.02     o Released February 24, 1991 (yet a little later, still)
  295.           o One small, but messy bug had to be cleaned up in this version.
  296.             It seems that the +filename option sent all but the very end of
  297.             thedirectory to the file.  The free space was accidentally echoed
  298.             to the CRT, instead of the file.  Hopefully version 3.x is
  299.             now in perfect condition.  It's kind of strange releasing three
  300.             versions in one day...
  301.           o Also, the Hidden, Read-only, and Volume ID options were being
  302.             ignored.  (However, those options aren't available to you
  303.             UNregistered users, anyway...)
  304.  
  305.  3.1      o Released May 15, 1991
  306.           o Added the ability to choose (via SDIRCFG.EXE) a SEPARATE method
  307.             for displaying free space for floppy drives and hard drives.
  308.             For example, you may now view your floppy drives' free space in
  309.             kilobytes, yet have your hard drives' free space displayed in
  310.             Megabytes.
  311.           o SDIRCFG.EXE was modified appropriately to allow the individual
  312.             selections of floppy/hard drive free space display methods.
  313.           o VERY IMPORTANT:  Version 3.1 uses a DIFFERENT format for the
  314.             SDIR.CFG file.  You must delete your old SDIR.CFG file and create
  315.             a new one with the new SDIRCFG.EXE program.
  316.           o This version also allows one new method of displaying free
  317.             space:  Percent.  This option displays the percent of your
  318.             disk drive that is empty.
  319.           o Several minor typos in the documentation and program code were
  320.             corrected.
  321.  
  322.  3.2      o Released July 17, 1991
  323.           o Added support for file descriptions in the form of two additional
  324.             column modes:  1 column with short or long descriptions.
  325.           o SDEDIT.EXE was created to allow file descriptions to be added
  326.             and modified.
  327.           o SDIRCFG.EXE was modified to allow new default selection of
  328.             column modes.
  329.           o VERY IMPORTANT:  Version 3.2 uses a DIFFERENT format for the
  330.             SDIR.CFG file.  You must delete your old SDIR.CFG file and create
  331.             a new one with the new SDIRCFG.EXE program.
  332.           o The option of displaying free space in percent has been modified
  333.             to include the free space in percent to ONE DECIMAL PLACE.  Now
  334.             you see 54.6% instead of 55%.
  335.           o Raised the official registration price to $10.
  336.           o Order form ORDER.TXT is now included.
  337.  
  338.  
  339.  
  340.  5.  Disclaimer
  341.  
  342. Although SmartDir contains no destructive code, and has been tested
  343. thoroughly, the author assumes no responsibility for loss of data or
  344. other damage to your computer system.  Your use of SmartDir is completely
  345. at your own risk.
  346.  
  347.  
  348.  
  349.  6.  Shareware Registration Information
  350.  
  351. SmartDir is shareware, which means, if you use it often and find it useful,
  352. you are politely asked to send a small fee to the author to REGISTER your
  353. copy.  Registered users sending $10 or more receive the latest version of
  354. SmartDir on diskette (please specify size:  3 or 5-inch).  In addition,
  355. registered users also have access to additional commands not available
  356. with the shareware version.
  357.  
  358. Please support shareware.  By paying a small fee for a piece of quality
  359. shareware, you are helping to fight the high cost of commercial software, and
  360. encouraging the production of future useful shareware programs.  Thank you.
  361.  
  362. If you would like to register your copy of SmartDir, please fill out
  363. the order form "ORDER.TXT", and mail it to:
  364.  
  365. Owen Emry
  366. 302 North Jefferson Street
  367. Arlington, Virgina  22203
  368.  
  369. Please feel free to include comments and/or suggestions,
  370. and thank you for supporting shareware.
  371.